Skip to content

Added conventional commits with JIRA scope. #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Added conventional commits with JIRA scope. #158

wants to merge 2 commits into from

Conversation

Crystalix007
Copy link
Contributor

This adds a new commit standard which basically enforces the scope of the conventional commit to be in the form project-issueNumber, in order to comply with JIRA issue tagging.

@codecov
Copy link

codecov bot commented Apr 11, 2020

Codecov Report

Merging #158 into master will decrease coverage by 4.18%.
The diff coverage is 40.29%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #158      +/-   ##
==========================================
- Coverage   91.54%   87.36%   -4.19%     
==========================================
  Files          33       35       +2     
  Lines         769      831      +62     
==========================================
+ Hits          704      726      +22     
- Misses         65      105      +40     
Flag Coverage Δ
#unittests 87.36% <40.29%> (-4.19%) ⬇️
Impacted Files Coverage Δ
...mmitizen/cz/conventional_jira/conventional_jira.py 31.03% <31.03%> (ø)
commitizen/__version__.py 100.00% <100.00%> (ø)
commitizen/cz/__init__.py 100.00% <100.00%> (ø)
commitizen/cz/conventional_jira/__init__.py 100.00% <100.00%> (ø)
commitizen/cz/exceptions.py 100.00% <100.00%> (ø)
commitizen/defaults.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7d4e3b9...95ebd27. Read the comment docs.

@woile
Copy link
Member

woile commented Apr 11, 2020

I don't know if this needs to be part of the library, looks more like a plugin, they can easily be created with commitizen_cz_template.
We can create here a new page with a list of alternative commit rules.

What do you think @Lee-W ?

@Lee-W
Copy link
Member

Lee-W commented Apr 11, 2020

@woile I agree with you. It seems to me we should include only the most used templates in commitizen itself to make it lightweight. Maybe we can create a awesome-commitizen-template list for it?

@woile
Copy link
Member

woile commented Apr 11, 2020

I'd link directly in the commitizen docs, like "Third party commitizen" or "Packages", or Catalog.

@Lee-W
Copy link
Member

Lee-W commented Apr 12, 2020

"Third party commitizen" seems to be a better one for me.

@Lee-W
Copy link
Member

Lee-W commented Apr 16, 2020

@Crystalix007 Thanks for your contribution! As discussed with @woile, we're not planning on making it a part of commitizen. Thus, I'm closing this PR. But we're happy to add this template as a third-party commitizen in our documentation. Please let us know if you want us to add it.

@Lee-W Lee-W closed this Apr 16, 2020
@Crystalix007
Copy link
Contributor Author

Sorry for the delay.

Is this okay?

The source is hosted here.

@woile
Copy link
Member

woile commented Apr 17, 2020

Yes, that's fine, you can create a PR for the docs, create a new section: Third party commitizen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants